/*
 * Copyright (C) 2010-2011 Enrique Lara (enrique.posix2.lara@gmail.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
 * limitations under the License.
  */
package app.timetogo.model;

import java.util.Comparator;

public interface Vehicle {
    /**
     * The short name of the destination station.
     */
    String getDestination();

    /**
     * The ID of destination station.
     */
    String getDestinationCode();

    /**
     * The name of destination station.
     */
    String getDestinationName();

    /**
     * Track number.
     */
    int getGroup();

    /**
     * ID of the metro line. Can be RD, BL, YL, OR, GR.
     */
    String getLine();

    /**
     * The minutes to arrival.
     */
    int getMinutes();

    /**
     * Can be "BRD", "ARR", or null.
     */
    String getStatus();

    Route getRoute();

    public static final class VehicleComparator implements Comparator<Vehicle> {
        public int compare(final Vehicle t0, final Vehicle t1) {
            if (t0.getMinutes() < t1.getMinutes()) {
                return -1;
            } else if (t0.getMinutes() > t1.getMinutes()) {
                return 1;
            } else {
                return 0;
            }
        }
    }
}
